<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>cr-parsing-location: Libcroco Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Libcroco Reference Manual">
<link rel="up" href="ch01.html" title="Extensive APIs description">
<link rel="prev" href="libcroco-cr-parser.html" title="cr-parser">
<link rel="next" href="libcroco-cr-prop-list.html" title="cr-prop-list">
<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#libcroco-cr-parsing-location.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libcroco-cr-parser.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libcroco-cr-prop-list.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libcroco-cr-parsing-location"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libcroco-cr-parsing-location.top_of_page"></a>cr-parsing-location</span></h2>
<p>cr-parsing-location</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libcroco-cr-parsing-location.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="libcroco-cr-parsing-location.html#CRParsingLocation" title="struct CRParsingLocation"><span class="returnvalue">CRParsingLocation</span></a> *
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-parsing-location.html#cr-parsing-location-new" title="cr_parsing_location_new ()">cr_parsing_location_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-parsing-location.html#cr-parsing-location-init" title="cr_parsing_location_init ()">cr_parsing_location_init</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-parsing-location.html#cr-parsing-location-copy" title="cr_parsing_location_copy ()">cr_parsing_location_copy</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-parsing-location.html#cr-parsing-location-to-string" title="cr_parsing_location_to_string ()">cr_parsing_location_to_string</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-parsing-location.html#cr-parsing-location-dump" title="cr_parsing_location_dump ()">cr_parsing_location_dump</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-parsing-location.html#cr-parsing-location-destroy" title="cr_parsing_location_destroy ()">cr_parsing_location_destroy</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libcroco-cr-parsing-location.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="libcroco-cr-parsing-location.html#CRParsingLocation" title="struct CRParsingLocation">CRParsingLocation</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="libcroco-cr-parsing-location.html#CRParsingLocationSerialisationMask" title="enum CRParsingLocationSerialisationMask">CRParsingLocationSerialisationMask</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libcroco-cr-parsing-location.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libcroco-cr-parsing-location.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="cr-parsing-location-new"></a><h3>cr_parsing_location_new ()</h3>
<pre class="programlisting"><a class="link" href="libcroco-cr-parsing-location.html#CRParsingLocation" title="struct CRParsingLocation"><span class="returnvalue">CRParsingLocation</span></a> *
cr_parsing_location_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns the newly instanciated <a class="link" href="libcroco-cr-parsing-location.html#CRParsingLocation" title="struct CRParsingLocation"><span class="type">CRParsingLocation</span></a>.
Must be freed by <a class="link" href="libcroco-cr-parsing-location.html#cr-parsing-location-destroy" title="cr_parsing_location_destroy ()"><code class="function">cr_parsing_location_destroy()</code></a></p>
</div>
<hr>
<div class="refsect2">
<a name="cr-parsing-location-init"></a><h3>cr_parsing_location_init ()</h3>
<pre class="programlisting">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
cr_parsing_location_init (<em class="parameter"><code><a class="link" href="libcroco-cr-parsing-location.html#CRParsingLocation" title="struct CRParsingLocation"><span class="type">CRParsingLocation</span></a> *a_this</code></em>);</pre>
<p>Initializes the an instance of <span class="type">CRparsingLocation</span>.</p>
<p>Returns CR_OK upon succesful completion, an error code otherwise.</p>
<div class="refsect3">
<a name="id-1.2.13.6.3.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>a_this</p></td>
<td class="parameter_description"><p>the current instance of <a class="link" href="libcroco-cr-parsing-location.html#CRParsingLocation" title="struct CRParsingLocation"><span class="type">CRParsingLocation</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cr-parsing-location-copy"></a><h3>cr_parsing_location_copy ()</h3>
<pre class="programlisting">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
cr_parsing_location_copy (<em class="parameter"><code><a class="link" href="libcroco-cr-parsing-location.html#CRParsingLocation" title="struct CRParsingLocation"><span class="type">CRParsingLocation</span></a> *a_to</code></em>,
                          <em class="parameter"><code><a class="link" href="libcroco-cr-parsing-location.html#CRParsingLocation" title="struct CRParsingLocation"><span class="type">CRParsingLocation</span></a> const *a_from</code></em>);</pre>
<p>Copies an instance of CRParsingLocation into another one.</p>
<p>Returns CR_OK upon succesful completion, an error code
otherwise.</p>
<div class="refsect3">
<a name="id-1.2.13.6.4.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>a_to</p></td>
<td class="parameter_description"><p>the destination of the copy.
Must be allocated by the caller.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>a_from</p></td>
<td class="parameter_description"><p>the source of the copy.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cr-parsing-location-to-string"></a><h3>cr_parsing_location_to_string ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
cr_parsing_location_to_string (<em class="parameter"><code><a class="link" href="libcroco-cr-parsing-location.html#CRParsingLocation" title="struct CRParsingLocation"><span class="type">CRParsingLocation</span></a> const *a_this</code></em>,
                               <em class="parameter"><code><span class="type">enum CRParsingLocationSerialisationMask</span> a_mask</code></em>);</pre>
<p>Returns the serialized string or NULL in case of an error.</p>
<div class="refsect3">
<a name="id-1.2.13.6.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>a_this</p></td>
<td class="parameter_description"><p>the current instance of <a class="link" href="libcroco-cr-parsing-location.html#CRParsingLocation" title="struct CRParsingLocation"><span class="type">CRParsingLocation</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>a_mask</p></td>
<td class="parameter_description"><p>a bitmap that defines which parts of the
parsing location are to be serialized (line, column or byte offset)</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cr-parsing-location-dump"></a><h3>cr_parsing_location_dump ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cr_parsing_location_dump (<em class="parameter"><code><a class="link" href="libcroco-cr-parsing-location.html#CRParsingLocation" title="struct CRParsingLocation"><span class="type">CRParsingLocation</span></a> const *a_this</code></em>,
                          <em class="parameter"><code><span class="type">enum CRParsingLocationSerialisationMask</span> a_mask</code></em>,
                          <em class="parameter"><code><span class="type">FILE</span> *a_fp</code></em>);</pre>
<div class="refsect3">
<a name="id-1.2.13.6.6.4"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>a_this</p></td>
<td class="parameter_description"><p>current instance of <a class="link" href="libcroco-cr-parsing-location.html#CRParsingLocation" title="struct CRParsingLocation"><span class="type">CRParsingLocation</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>a_mask</p></td>
<td class="parameter_description"><p>the serialization mask.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>a_fp</p></td>
<td class="parameter_description"><p>the file pointer to dump the parsing location to.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cr-parsing-location-destroy"></a><h3>cr_parsing_location_destroy ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cr_parsing_location_destroy (<em class="parameter"><code><a class="link" href="libcroco-cr-parsing-location.html#CRParsingLocation" title="struct CRParsingLocation"><span class="type">CRParsingLocation</span></a> *a_this</code></em>);</pre>
<p>Destroys the current instance of <a class="link" href="libcroco-cr-parsing-location.html#CRParsingLocation" title="struct CRParsingLocation"><span class="type">CRParsingLocation</span></a></p>
<div class="refsect3">
<a name="id-1.2.13.6.7.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>a_this</p></td>
<td class="parameter_description"><p>the current instance of <a class="link" href="libcroco-cr-parsing-location.html#CRParsingLocation" title="struct CRParsingLocation"><span class="type">CRParsingLocation</span></a>. Must
have been allocated with <a class="link" href="libcroco-cr-parsing-location.html#cr-parsing-location-new" title="cr_parsing_location_new ()"><code class="function">cr_parsing_location_new()</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="libcroco-cr-parsing-location.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="CRParsingLocation"></a><h3>struct CRParsingLocation</h3>
<pre class="programlisting">struct CRParsingLocation {
	guint line ;
	guint column ;
	guint byte_offset ;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="CRParsingLocationSerialisationMask"></a><h3>enum CRParsingLocationSerialisationMask</h3>
<div class="refsect3">
<a name="id-1.2.13.7.3.3"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="DUMP-LINE:CAPS"></a>DUMP_LINE</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="DUMP-COLUMN:CAPS"></a>DUMP_COLUMN</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="DUMP-BYTE-OFFSET:CAPS"></a>DUMP_BYTE_OFFSET</p></td>
<td> </td>
<td> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>